3.4 Configuring SMS and email notifications

You can choose whether to allow SMS, email, or both types of notification when sending provisioning messages to mobile devices.

MyID sends two notifications:

The two components of the notification (the collection URL and the authentication code) are sent separately for security, and you are recommended to configure MyID to send the collection URL as an email and the authentication code as a SMS for additional security.

3.4.1 Configuring SMS and email notifications for the MyID Operator Client

You control the way MyID sends notifications for the issuance of mobile identities through the MyID Operator Client by setting the notification scheme in the credential profile; see section 3.8.1, Creating the Identity Agent credential profile.

You must enable the notification methods using configuration options.

To enable SMS and email notifications:

  1. From the Configuration category, select the Operation Settings workflow.

  2. On the General tab, set the following options:

    • SMS email notifications – set to Yes to allow authentication codes to be sent through SMS.

      If you do not set this option to Yes, you must configure the credential profile to send the authentication code as an email, or display the authentication code on screen when you request the mobile device.

    • SMS gateway URL for notifications – set to the URL of your SMS gateway.

      By default, SMS messages are sent to through an email to SMS gateway, in the format <cellnumber>@<gateway>, where:

      • <cellnumber> – the cell phone number from the person's record.

      • <gateway> – the URL from the SMS gateway URL for notifications option.

      For example: [email protected]

      If this is not suitable, you can customize the sp_CustomPrepareSMS stored procedure in the MyID database.

  3. On the Notifications tab, set the following option:

    • Send Email Notifications – set to Yes to allow notifications to be sent through email.

      You must configure an SMTP server in the External Systems workflow; see the Setting up email section in the Advanced Configuration Guide.

  4. On the Issuance Processes tab, set the following options:

    • App Download URL – ANDROID – the URL where the Android version of the Identity Agent app is available for download.

    • App Download URL – iOS – the URL where the iOS version of the Identity Agent app is available for download.

    If you click on a provisioning URL on a mobile device, but do not have the Identity Agent app installed, these links are displayed to allow you to download the app and try again. See the Issuance Processes page (Operation Settings) section of the Administration Guide for further details of these options.

  5. Click Save changes.

3.4.2 Configuring SMS and email notifications for MyID Desktop

You control the way MyID sends notifications for the issuance of mobile identities through MyID Desktop by setting configuration options.

To allow provisioning messages:

  1. From the Configuration category, select the Operation Settings workflow.

  2. On the Devices tab, set the following options:

    • Mobile Provision Via Email – set this option to allow the notifications of mobile IDs to be sent to the user's email address.

    • Mobile Provision Via SMS – set this option to allow the notifications of mobile IDs to be sent to the user's mobile phone number.

    Note: You can select one or both of these options. If you select both options, you can select which method to use when you request the mobile identity.

  3. On the Notifications tab, set the following options:

    • Send Mobile OTP via SMS – set this option to allow the operator to send the OTP authentication code directly to the mobile device.

      Note: If you set Send Mobile OTP via SMS to Yes, as a security feature, the OTP is sent as an SMS while the notification message must be sent using email and not SMS; make sure you select the Mobile Provision Via Email option on the Devices tab.

    • Mail Format – make sure this option is set to HTML.

  4. Click Save changes.

3.4.3 Configuring the SMS gateway for MyID Desktop

You can configure the system to use any SMS gateway. You must customize the following file:

customSMS.asp

Versions of this file are installed to the MyID web server in the following locations:

Where <edition> is WebPIV for PIV, and WebENT for non-PIV editions of MyID.

You must make the same changes in each version of the file. If you have created any custom translations of the MyID web site, you must also make the same change in the custom versions.

The sample file installed with the system is set up to use the SMS gateway provided by www.2sms.com – if you are using this service, edit the username line to include your 2sms account, and the password line to include your 2sms password.

If you are using any other system, you must customize the ASP file to conform to the calling requirements of your own SMS gateway.

This ASP file implements the following function:

customSendSMS(message, mobileNumber, userRS)

where:

The function returns the response from the SMS gateway.

You can implement your system in any way. You are required only to send the body contained in message to the phone number in mobileNumber, and return the response from the gateway.

Note: You must keep a backup of this file once you have customized it.

3.4.4 Configuring SMS and email certificate renewal notifications

This section is relevant for certificate renewal notifications whether you issued the mobile device through the MyID Operator Client on through MyID Desktop.

You can decide whether to send renewal messages through email, through SMS, or through both email and SMS.

To allow MyID to send SMS messages, set the SMS email notifications on the General tab of the Operation Settings workflow to Yes.

By default, SMS messages are sent to an Email to SMS gateway, in the format <cellnumber>@<gateway>, where:

For example: [email protected]

If this is not suitable, you can customize the sp_CustomPrepareSMS stored procedure in the MyID database.

You can use different content for email and SMS certificate renewal messages, and different content for different kinds of device – mobile or card, for example. Six additional renewal messages are provided – three messages for SMS to mobile devices, and three messages for email to mobile devices. Use the Email Templates workflow to edit the content of these messages.

Note: If you have upgraded your MyID system, MyID does not update your stored procedure to prevent the overwriting of your changes. The base stored procedure has been updated, and you must edit the sp_CustomPrepareSMS stored procedure to allow it to work. If your stored procedure contains the following:

-- Output an XML string
@xml NVARCHAR(MAX) OUT

change it to:

-- Output an XML string
@xml NVARCHAR(4000) OUT